home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / setr180.zip / README.1ST < prev    next >
Text File  |  1997-06-07  |  7KB  |  118 lines
  1.       Read this file before using SETR's history reporting feature!!!
  2.  
  3.    With the release of version 1.50, SETR has grown into a pretty complex
  4. program.  I have attempted to keep the docs short and to the point, but
  5. there has been some confusion about the history reporting functions, so I
  6. decided to add this explanation instead of adding to the docs.  Hopefully
  7. after reading this, and playing with SETR and the history functions for a
  8. while, all you will need to refer to is the docs in the future.
  9.  
  10.    First of all, when the history updating is activated by the /HU switch,
  11. SETR will scan the log file as before, but it will then create three data
  12. files to store the history information.
  13.  
  14.    SQHIST.DTE   This is the begin and end dates for the history files.
  15.    SQHIST.TAG   This is the areatag data for the history reports.
  16.    SQHIST.ORG   This is the origin address data for the history reports.
  17.  
  18.    Each time SETR is run with the /HU switch, the traffic stats for the
  19. current log file are appended to the existing history data files.  The data
  20. files are then sorted and consolidated producing updated history data
  21. files.  If the /HR switch has also been used, the history data files are
  22. read in, and the History Report is generated.  If you are only tracking a
  23. single network, or just tracking all of your mail in one report, the
  24. process is pretty simple and quick.  All that needs to be explained is how
  25. to setup your history reporting period.
  26.  
  27.    On my system, I maintain a weekly history report, beginning on Sunday,
  28. and ending at midnight Saturday.  Therefore, my daily maintenance event
  29. has the following SETR command in it:
  30.  
  31.    SETR RPT=SQ-DAILY.RPT HST=SQWEEKLY /HU /HR /AP
  32.  
  33.    The above command tells SETR to scan my SQUISH.LOG file, produce a daily
  34. traffic report "SQ-DAILY.RPT", which is appended to each day, and create /
  35. update SQWEEKLY.DTE, SQWEEKLY.TAG, SQWEEKLY.ORG, and SQWEEKLY.RPT.  The
  36. SQWEEKLY.RPT file is overwritten each night with the updated history
  37. report.
  38.  
  39.    On Saturday night / Sunday morning, I run the same command with /HK
  40. added to the command line.  That tells SETR to do everything the same,
  41. except that after the history report, SQWEEKLY.RPT, is written, the history
  42. data files are deleted.  The SQ-DAILY.RPT, and SQWEEKLY.RPT files are
  43. packed away in another part of the event, and the system is ready to begin
  44. again on Sunday night.
  45.  
  46.    The difference in the commands used above, and the default history
  47. report settings, is that with the commands above, SETR created and updated
  48. SQWEEKLY.DTE, SQWEEKLY.TAG, SQWEEKLY.ORG, and SQWEEKLY.RPT instead of the
  49. SQHIST.* filenames that would be used if the HST=SQWEEKLY option had not
  50. been used.
  51.  
  52.    And this is where SETR can become a powerful reporting tool.  If you
  53. want to produce a consolidated traffic report, and a report for each of the
  54. nets that you have on your system, all that you need to do is run SETR once
  55. for each report that you want to create.  Here is how I track my mail
  56. traffic in more detail:
  57.  
  58.       SETR RPT=FN-DAILY.RPT HST=FNWEEKLY /XFIDONET.XCL /HU /HR /AP
  59.       SETR RPT=IN-DAILY.RPT HST=INWEEKLY /XITCNET.XCL /HU /HR /AP
  60.       SETR RPT=NM-DAILY.RPT HST=NMWEEKLY /XNETMAIL.XCL /HU /HR /AP
  61.       SETR RPT=PN-DAILY.RPT HST=PNWEEKLY /XPWCNET.XCL /HU /HR /AP
  62.       SETR RPT=RN-DAILY.RPT HST=RNWEEKLY /XRGSNET.XCL /HU /HR /AP
  63.       SETR RPT=SQ-DAILY.RPT HST=SQWEEKLY /HU /HR /AP /KL
  64.  
  65.    First I had to create five tag exclusion files in the directory named:
  66. FIDONET.XCL, ITCNET.XCL, NETMAIL.XCL, PWCNET.XCL, and RGSNET.XCL.  The
  67. FIDONET.XCL file contains all of the areatags that do not come from
  68. FidoNet,  and the ITCNET.XCL file contains all of the areatags that do not
  69. come from ITCNet, and so on.  Those files are all identified by the /X
  70. switch.
  71.  
  72.    When this group of commands is executed, I get the following results:
  73.  
  74.    NET     DAILY RPT   DATES HST    AREATAG HST  ORIGIN HST   HISTORY RPT
  75.  FIDONET FN-DAILY.RPT FNWEEKLY.DTE FNWEEKLY.TAG FNWEEKLY.ORG FNWEEKLY.RPT
  76.  ITCNET  IN-DAILY.RPT INWEEKLY.DTE INWEEKLY.TAG INWEEKLY.ORG INWEEKLY.RPT
  77.  NETMAIL NM-DAILY.RPT NMWEEKLY.DTE NMWEEKLY.TAG NMWEEKLY.ORG NMWEEKLY.RPT
  78.  PWCNET  PN-DAILY.RPT PNWEEKLY.DTE PNWEEKLY.TAG PNWEEKLY.ORG PNWEEKLY.RPT
  79.  RGSNET  RN-DAILY.RPT RNWEEKLY.DTE RNWEEKLY.TAG RNWEEKLY.ORG RNWEEKLY.RPT
  80.  SQUISH  SQ-DAILY.RPT SQWEEKLY.DTE SQWEEKLY.TAG SQWEEKLY.ORG SQWEEKLY.RPT
  81.  
  82.    Notice that the last command line does not contain a /X switch, because
  83. it is the consolidated report, including all of the traffic thru the
  84. system.  Also, there is a /KL switch on the end of the last command line.
  85. That tells SETR to delete the SQUISH.LOG file after all of the reports have
  86. been processed.  Once again, in my weekly event, which runs at midnight on
  87. Saturdays, all of the above commands also have a /HK switch to delete the
  88. history files after the history reports have been generated, thus making
  89. the system ready for the next week's reports.  That event also packs up and
  90. moves all of the reports out of the reporting directory so they won't be in
  91. the way.
  92.  
  93.    The command lines below would create exactly the same files and reports,
  94. but the tag exclusion files would have to be named: FNWEEKLY.XCL,
  95. INWEEKLY.XCL, NMWEEKLY.XCL, PNWEEKLY.XCL, and RNWEEKLY.XCL instead of the
  96. names used in the example above.  The difference is the /Z switch, which
  97. combines the HST= and /X arguments into a single argument:
  98.  
  99.       SETR RPT=FN-DAILY.RPT /ZFNWEEKLY /HU /HR /AP
  100.       SETR RPT=IN-DAILY.RPT /ZINWEEKLY /HU /HR /AP
  101.       SETR RPT=NM-DAILY.RPT /ZNMWEEKLY /HU /HR /AP
  102.       SETR RPT=PN-DAILY.RPT /ZPNWEEKLY /HU /HR /AP
  103.       SETR RPT=RN-DAILY.RPT /ZRNWEEKLY /HU /HR /AP
  104.       SETR RPT=SQ-DAILY.RPT HST=SQWEEKLY /HU /HR /AP /KL
  105.  
  106.    Notice also that the .XCL file extension is not included when the /Z
  107. switch is used, but is optional when using the /X switch.
  108.  
  109.    A word of warning to those who are going to be using the tag exclusion
  110. files.  SETR cannot update those files itself, so when you add new areatags
  111. to your SQUISH.CFG file, be sure to update the tag exclusion files as well.
  112. Failure to do so will result in the wrong echo areas being reported in your
  113. reports.  It will also help if you remove any unused areatags from the tag
  114. exclusion files whenever you drop areas from your SQUISH.CFG file, but it
  115. won't hurt your reports if you leave them in, unless you are at the 500
  116. line limit on the tag exclusion file.
  117.  
  118.